Skip to main content

Template Package Structure

The Template Package is a zip file containing specific files and folders that can interpreted by the Template Package deployment mechanism. The zip file must follow a prescribed specification in order to be deployable, extensible, and avoid collisions with future enhancements.

Top Level Structure#

Template Package.zip /||-- configs /|-- omapiConfig /|-- scripts /||-- manifest.json|-- README.md

Manifest.json#

The Template Package must contain a 'manifest.json' file at the root of the package and the content of the manifest.json file must conform to the specification defined in the Template Package Manifest documentation.

The manifest.json defines the content of the Template Package and how it should be deployed. The manifest.json will have direct references to the files and folders in the package itself.

For more information on the manifest.json see the Template Package Manifest documentation.

Folders#

The root of the zip file may optionally contain folders named 'configs', 'omapiConfig', and 'scripts'. These folders contain files used to describe data to be recreated in Twinit when the package is deployed.

If a Template Package does not make use of user configs, API configs, or scripts then any of the folders may not exist in a Template Package or be may be empty.

README.md#

The package can optionally include a README in markdown or ay other format such as pdf or txt. The README can be used to provide any information the consumer of the Template Package may need.